Resource {uuid}

Path: / v310 / appliance / {uuid}

Path parameters:: uuid - Appliance Tintri UUID

Resources
Name	Description
action=testEmail	Deprecated. Tests alert mail.
action=testSNMP	Deprecated. Send a SNMP test trap to a remote trap receiver host.
action=testSyslogForwarding	Deprecated. Send a test log forwarding message to the remote host.
action=upgrade	Deprecated. Starts the Tintri appliance upgrade.
alertCounts	Gets the number of notifications on appliance
certificate	Returns any present host certificate and trusted Certificate Authority (CA) certificates.
component	Gets the Tintri appliance components.
connectivity ↳ connectivity/testPing	Ping test.
controller	Gets the Tintri appliance controllers.
csiProperties	Gets CSI properties.
customizationInfo	Gets the Tintri appliance customization information, which includes replication interface and space saving support.
dataProtectionConfig	Returns the Tintri appliance data protection config.
dateTime	Returns the date and time settings.
disk	Gets the Tintri appliance disks.
dns	Gets the Tintri appliance DNS setting.
emailalerts	Gets the Tintri appliance alert email configuration.
enableEncryption	Enables disk encryption.
encryptionInfo	Gets the disk encryption information.
escalateDPAPrivileges	Escalates DATA_PROTECTION_ADMIN user's privilges until the time specific by escalatedPrivilegeExpiryTimeMs.
expand	Deprecated. Expands the storage capacity of the Tintri appliance after successful HA failover, the additional capacity will be added to realstore's single large RAID group.
failedComponents	Gets the failed hardware parts that need to be replaced.
fileDirInfo ↳ fileDirInfo/{path}	Fetch the file system information associated with the entity specificed by path.
hafailover	API to perform HA failover.
info	Gets the Tintri appliance basic information, which includes serial number, model name, OS verison, and product ID.
ipmi	Gets IPMI configuration.
ips	Gets the Tintri appliance IP configurations.
lacp	Gets LACP configuration.
lldp	Returns the LLDP info for both controllers.
maintenanceMode	Gets maintenance mode.
operationalStatus	Gets the Tintri appliance operational status, which contains sample time, up time, count of unread alerts, file system status, urgent message.
rbacExternalConfig	Returns the external directory service authentication configuration.
reboot	API to perform Appliance reboot operation
rebootSecondary	API to perform secondary reboot operation
restartAuthd	Restart the AuthenticationService (authd).
restartDb	Restarts the application database.
restartSnmp	Restart the snmp-agent.
restartWebServer	Restart the web server.
rotateEncryptionKey	Rotates the disk encryption key.
rpcReport	Generates a report of external RPC connection to filesystem in /var/log/tintri/rpc-connections-external.txt
shutdown	API to perform Appliance shutdown operation
snmp	Gets the sytem SNMP configuration.
snmpTarget	Get all the SNMP trap targets information.
snmpUser	Gets SNMP users.
stagingAreaInfo	Gets the Tintri appliance staging area information, which includes details about the space, software uploaded etc.
support	Gets the Tintri appliance autosupport settings.
syslogForwarding	Gets the log forwarding info.
temperature	Gets the Tintri appliance termperatures.
testEmail	Tests alert mail.
testEncryption	Tests disk encryption.
testRbacExternalConfig	Test the external directory service authentication configuration.
testSNMP	Send a SNMP test trap to a remote trap receiver host.
testSyslogForwarding	Send a test log forwarding message to the remote host.
timezones	Returns list of all time zones supported by the server.
upgrade	Starts the Tintri appliance upgrade.
upgradeInfo	Gets the Tintri appliance upgrade information, which includes upgrade state, checksum, verison, error message.

Method Summary
Resource	Description
`GET /v310/appliance/{uuid}`	Gets Tintri Appliance properties. The value 'default' should be used for {uuid} on VMstore server. Information about appliance operation, customization, upgrade, controllers, disks, temperatures, power, maintenance mode, disk encryption and redundancy is returned.
`PUT /v310/appliance/{uuid}`	Updates Tintri appliance's specified properties. The value 'default' should be used for {uuid}. Tomcat should be restarted if appliance DNS, time zone or host certificate is updated for the VMstore. On TGC, only an ApplianceIp can be added on a VMStore, using this API. For any other specified property, an error will be returned. Also a VMStore's tintriUuid must be used for {uuid} property, on which the new ApplianceIp needs to be created for the SyncRepl configuration.

HTTP Example:

GET /v310/appliance/{uuid}

API Example:

ApplianceResource.getAppliance({'uuid': /* uuid Appliance Tintri UUID */});

Description:

Gets Tintri Appliance properties. The value 'default' should be used for {uuid} on VMstore server. Information about appliance operation, customization, upgrade, controllers, disks, temperatures, power, maintenance mode, disk encryption and redundancy is returned.

Tintri Api Server Support:: All
Query parameter Reference:: ApplianceFilterSpec
Output:: List<Appliance> - List of Appliance instances
Errors:
Produces:: application/json;qs=1, application/xml;qs=0.5
Consumes:: application/json;qs=1, application/xml;qs=0.5

HTTP Example:

PUT /v310/appliance/{uuid}

API Example:

ApplianceResource.updatePlatform({'uuid': /* uuid Appliance Tintri UUID */, '$entity': /* platformContainer The request contains properties to update */});

Description:

Updates Tintri appliance's specified properties. The value 'default' should be used for {uuid}. Tomcat should be restarted if appliance DNS, time zone or host certificate is updated for the VMstore. On TGC, only an ApplianceIp can be added on a VMStore, using this API. For any other specified property, an error will be returned. Also a VMStore's tintriUuid must be used for {uuid} property, on which the new ApplianceIp needs to be created for the SyncRepl configuration.

Tintri Api Server Support:: All
Input:: Request<Appliance> - The request contains properties to update
Output:: void
Errors:
Produces:: application/json;qs=1, application/xml;qs=0.5
Consumes:: application/json;qs=1, application/xml;qs=0.5